ipv6 support for remote addresses added #3361
Open
+96
−213
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Added extra fixes, as the "Elasticsearch API method" of both ECE -> self-managed and ECH -> self-managed docs were incorrect! |
deploy-manage/remote-clusters/_snippets/rcs-elasticsearch-api-snippet-self.md
Outdated
Show resolved
Hide resolved
…snippet-self.md Co-authored-by: florent-leborgne <[email protected]>
shainaraskas
approved these changes
Oct 7, 2025
Comment on lines
14
to
20
| * **Remote address**: Enter the endpoint of the remote self-managed cluster, including the hostname, FQDN, or IP address, and the port. Both IPv4 and IPv6 ({applies_to}`stack: ga 9.2`) addresses are supported. | ||
|
|
||
| Make sure you use the correct port for your authentication method: | ||
| * **API keys**: Use the port configured in the remote cluster interface of the remote cluster (defaults to `9443`). | ||
| * **TLS Certificates**: Use the {{es}} transport port (defaults to `9300`). | ||
|
|
||
| When using an IPv6 address ({applies_to}`stack: ga 9.2`), enclose it in square brackets followed by the port number. For example: `[2001:db8::1]:9443`. |
There was a problem hiding this comment.
we generally don't want to use these tags inline like that. consider using a note instead. we should also direct people to use the api if they want to set a v6 address in 9.1 and earlier
There was a problem hiding this comment.
I don't want a note to highlight that ipv6 is supported in 9.2 onwards. It's not important enough IMO to highlight it within a note.
I can change the text to remove the badge and say: "Starting on 9.2 this field supports IPv6 addresses".
| To configure a self-managed cluster as a remote cluster, use the [cluster update settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings). Configure the following fields: | ||
|
|
||
| * `mode`: `proxy` | ||
| * `proxy_address`: Enter the endpoint of the remote self-managed cluster, including the hostname, FQDN, or IP address, and the port. Both IPv4 and IPv6 ({applies_to}`stack: ga 9.2`) addresses are supported. |
There was a problem hiding this comment.
this is not specific to 9.2 here is it?
florent-leborgne
approved these changes
Oct 8, 2025
Comment on lines
+14
to
+20
| * **Remote address**: Enter the endpoint of the remote self-managed cluster, including the hostname, FQDN, or IP address, and the port. Starting with {{kib}} 9.2, this field also supports IPv6 addresses. | ||
|
|
||
| Make sure you use the correct port for your authentication method: | ||
| * **API keys**: Use the port configured in the remote cluster interface of the remote cluster (defaults to `9443`). | ||
| * **TLS Certificates**: Use the {{es}} transport port (defaults to `9300`). | ||
|
|
||
| When using an IPv6 address, enclose it in square brackets followed by the port number. For example: `[2001:db8::1]:9443`. |
There was a problem hiding this comment.
Suggested change
| * **Remote address**: Enter the endpoint of the remote self-managed cluster, including the hostname, FQDN, or IP address, and the port. Starting with {{kib}} 9.2, this field also supports IPv6 addresses. | |
| Make sure you use the correct port for your authentication method: | |
| * **API keys**: Use the port configured in the remote cluster interface of the remote cluster (defaults to `9443`). | |
| * **TLS Certificates**: Use the {{es}} transport port (defaults to `9300`). | |
| When using an IPv6 address, enclose it in square brackets followed by the port number. For example: `[2001:db8::1]:9443`. | |
| * **Remote address**: Enter the endpoint of the remote self-managed cluster, including the hostname, FQDN, or IP address, and the port. | |
| Make sure you use the correct port for your authentication method: | |
| * **API keys**: Use the port configured in the remote cluster interface of the remote cluster (defaults to `9443`). | |
| * **TLS Certificates**: Use the {{es}} transport port (defaults to `9300`). | |
| Starting with {{kib}} 9.2, this field also supports IPv6 addresses. When using an IPv6 address, enclose it in square brackets followed by the port number. For example: `[2001:db8::1]:9443`. |
Since this content is no longer in notes/tips, I suggest we group the IPv6 bits together, after the most important part to read (like ports information)
| * **TLS server name**: Specify a value if the certificate presented by the remote cluster is signed for a different name than the remote address. | ||
| * **Socket connections**: Define the number of connections to open with the remote cluster. | ||
|
|
||
| For a full list of available client connection settings, refer to [remote cluster settings reference](elasticsearch://reference/elasticsearch/configuration-reference/remote-clusters.md#remote-cluster-proxy-settings). |
There was a problem hiding this comment.
Is this relevant for the UI configuration exposed in the Kibana UI, or are we saying that there are more options if users do it through the API? If the latter, we can make it a little bit clearer as it becomes an alternative more than complimentary information
| 3. Specify the {{es}} endpoint URL, or the IP address or host name of the remote cluster followed by the remote cluster port (defaults to `9443`). For example, `cluster.es.eastus2.staging.azure.foundit.no:9443` or `192.168.1.1:9443`. | ||
| 3. Specify the {{es}} endpoint URL, the IP address, or host name of the remote cluster, followed by the remote cluster port (defaults to `9443`). For example, `cluster.es.eastus2.staging.azure.foundit.no:9443` or `192.168.1.1:9443`. | ||
| Both IPv4 and IPv6 ({applies_to}`stack: ga 9.2`) addresses are supported. |
There was a problem hiding this comment.
Suggested change
| Both IPv4 and IPv6 ({applies_to}`stack: ga 9.2`) addresses are supported. | |
| Starting with {{kib}} 9.2, you can also specify IPv6 addresses. |
To make it closer to your other edit where you no longer use a badge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR describes that the Stack 9.2 supports IPv6 addresses when configuring a remote cluster within Kibana.
I don't want to highlight that much in our docs, as it doesn't feel necessary (we didn't even mention that we supported IPv4 at all, neither that IPv6 wasn't supported by Kibana (it was supported by Elasticsearch)).
Extra improvements:
Not updated (out of the scope of this PR)
Closes #3093